Skip to content

chore: add MCP Registry submission files and per-client config snippets#12

Merged
shenxianpeng merged 1 commit into
mainfrom
chore/add-mcp-registry-and-client-configs
Jul 2, 2026
Merged

chore: add MCP Registry submission files and per-client config snippets#12
shenxianpeng merged 1 commit into
mainfrom
chore/add-mcp-registry-and-client-configs

Conversation

@shenxianpeng

Copy link
Copy Markdown
Member

Summary

This PR addresses the lack of visibility for commit-check-mcp in the MCP ecosystem. It adds everything needed for submission to the official MCP Registry and provides ready-to-use config snippets for mainstream MCP clients.

Changes

1. server.json — Official MCP Registry Submission

  • New file: server.json with server metadata for the MCP Registry
  • Server name: io.github.commit-check/commit-check-mcp (PyPI package type)
  • Includes tool list, categories, and runtimeHint for uvx

2. README.md — Ownership Verification

  • Added <!-- mcp-name: io.github.commit-check/commit-check-mcp --> HTML comment (required by MCP Registry for PyPI ownership verification)

3. README.md — Per-Client Config Snippets

Replaced the generic single-config section with ready-to-copy-paste snippets for 8 mainstream clients:

Client Config Location
Claude Desktop claude_desktop_config.json
Claude Code CLI ~/.claude/settings.json
Cursor Settings UI or .cursor/mcp.json
Windsurf ~/.codeium/windsurf/mcp_config.json
Cline (VS Code) Cline extension settings
Continue.dev ~/.continue/config.json
Roo Code Roo Code MCP settings
Zed ~/.config/zed/settings.json

All snippets use uvx commit-check-mcp (zero-install) as the recommended approach.

4. README.md — New Badges & "Published On" Section

  • MCP Registry badge
  • Glama.ai badge
  • "Published On" table linking to MCP Registry, Glama, and PyPI
  • Links to awesome-mcp-servers and Smithery for future directory submissions

5. README.md — Run Manually Update

  • Added uvx commit-check-mcp as the zero-install alternative

Post-Merge Steps

After this PR is merged, the repo owner should publish to the MCP Registry:

# Install mcp-publisher
brew install mcp-publisher

# Authenticate with GitHub
mcp-publisher login github

# Publish
mcp-publisher publish

Then submit PRs to add to community directories:

- Add server.json for official MCP Registry (io.github.commit-check/commit-check-mcp)
- Add mcp-name HTML comment for PyPI ownership verification
- Add MCP Registry and Glama badges to README header
- Rewrite 'Use With An MCP Client' section with ready-to-use config
  snippets for: Claude Desktop, Claude Code CLI, Cursor, Windsurf,
  Cline, Continue.dev, Roo Code, and Zed
- Recommend uvx as the primary zero-install runner
- Add 'Published On' table with links to MCP Registry, Glama, PyPI
- Add instructions for contributing to awesome-mcp-servers and Smithery
@github-actions github-actions Bot added chore documentation Improvements or additions to documentation labels Jul 2, 2026
@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@shenxianpeng, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 24 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 67337a98-f588-4419-873c-38111b62bec1

📥 Commits

Reviewing files that changed from the base of the PR and between f785021 and 157ac9a.

📒 Files selected for processing (2)
  • README.md
  • server.json
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/add-mcp-registry-and-client-configs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 66.02%. Comparing base (f785021) to head (157ac9a).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #12   +/-   ##
=======================================
  Coverage   66.02%   66.02%           
=======================================
  Files           2        2           
  Lines         209      209           
=======================================
  Hits          138      138           
  Misses         71       71           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@shenxianpeng shenxianpeng removed the documentation Improvements or additions to documentation label Jul 2, 2026
@shenxianpeng shenxianpeng merged commit 92f47d5 into main Jul 2, 2026
7 checks passed
@shenxianpeng shenxianpeng deleted the chore/add-mcp-registry-and-client-configs branch July 2, 2026 20:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants